home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / librw / RWDlistCollectables.z / RWDlistCollectables
Encoding:
Text File  |  2002-10-03  |  15.0 KB  |  331 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))                            RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWDlistCollectables - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               #include <rw/dlistcol.h>
  13.  
  14.  
  15.  
  16.               RWDlistCollectables a;
  17.  
  18.  
  19.  
  20.  
  21. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  22.      Class RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss represents a group of ordered items, not
  23.      accessible by an external key.  Duplicates are allowed.  The ordering of
  24.      elements is determined externally, generally by the order of insertion
  25.      and removal.  An object stored by RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss must inherit
  26.      abstract base class RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee.  Class RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss is
  27.      implemented as a doubly-linked list, which allows for efficient insertion
  28.      and removal, as well as for movement in either direction.
  29.  
  30. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  31.      Polymorphic
  32.  
  33. PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
  34.               RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss();
  35.  
  36.  
  37.      Constructs an empty doubly-linked list.
  38.  
  39.               RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss (RWCollectable* a);
  40.  
  41.  
  42.      Constructs a linked list with a single item aaaa.
  43.  
  44. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrrssss
  45.               RWBoolean
  46.           ooooppppeeeerrrraaaattttoooorrrr========(const RWDlistCollectables& d) const;
  47.  
  48.  
  49.      Returns TTTTRRRRUUUUEEEE if self and dddd have the same number of items and if for every
  50.      item in self, the corresponding item in the same position in dddd iiiissssEEEEqqqquuuuaaaallll to
  51.      it.
  52.  
  53. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  54.               virtual Collectable*
  55.           aaaappppppppeeeennnndddd(RWCollectable*);
  56.  
  57.  
  58.      Redefined from RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee.  Inserts the item at the end of the
  59.      collection and returns it.  Returns nnnniiiillll if the insertion was unsuccesful.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))                            RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.               virtual void
  75.           aaaappppppppllllyyyy(RWapplyCollectable ap, void*);
  76.  
  77.  
  78.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn to apply the user-supplied function
  79.      pointed to by aaaapppp to each member of the collection, in order, from first
  80.      to last.
  81.  
  82.               virtual RWCollectable*&
  83.           aaaatttt(size_t i);
  84.           virtual const RWCollectable*
  85.           aaaatttt(size_t i) const;
  86.  
  87.  
  88.      Redefined from class RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee.  The index must be between zero and
  89.      the number of items in the collection less one, or an exception of type
  90.      RRRRWWWWBBBBoooouuuunnnnddddssssEEEErrrrrrrr will occur.  Note that for a linked list, these functions
  91.      must traverse all the links, making them not particularly efficient.
  92.  
  93.               virtual RWspace
  94.           bbbbiiiinnnnaaaarrrryyyySSSSttttoooorrrreeeeSSSSiiiizzzzeeee() const;
  95.  
  96.  
  97.      Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  98.  
  99.               virtual void
  100.           cccclllleeeeaaaarrrr();
  101.  
  102.  
  103.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  104.  
  105.               virtual void
  106.           cccclllleeeeaaaarrrrAAAAnnnnddddDDDDeeeessssttttrrrrooooyyyy();
  107.  
  108.  
  109.      Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  110.  
  111.               virtual int
  112.           ccccoooommmmppppaaaarrrreeeeTTTToooo(const RWCollectable* a) const;
  113.  
  114.  
  115.      Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee.
  116.  
  117.               virtual RWBoolean
  118.           ccccoooonnnnttttaaaaiiiinnnnssss(const RWCollectable* target) const;
  119.  
  120.  
  121.      Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  122.  
  123.               RWBoolean
  124.           ccccoooonnnnttttaaaaiiiinnnnssssRRRReeeeffffeeeerrrreeeennnncccceeee(const RWCollectable* e) const;
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))                            RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))
  137.  
  138.  
  139.  
  140.      Returns true if the list contains an item that iiiissss iiiiddddeeeennnnttttiiiiccccaaaallll ttttoooo the item
  141.      pointed to by eeee (that is, that has the address eeee).
  142.  
  143.               virtual size_t
  144.           eeeennnnttttrrrriiiieeeessss() const;
  145.  
  146.  
  147.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  148.  
  149.               virtual RWCollectable*
  150.           ffffiiiinnnndddd(const RWCollectable* target) const;
  151.  
  152.  
  153.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.  The first item that iiiissssEEEEqqqquuuuaaaallll to the
  154.      item pointed to by ttttaaaarrrrggggeeeetttt is returned, or nnnniiiillll if no item is found.
  155.  
  156.               RWCollectable*
  157.           ffffiiiinnnnddddRRRReeeeffffeeeerrrreeeennnncccceeee(const RWCollectable* e) const;
  158.  
  159.  
  160.      Returns the first item that iiiissss iiiiddddeeeennnnttttiiiiccccaaaallll ttttoooo the item pointed to by eeee
  161.      (that is, that has the address eeee), or nnnniiiillll if none is found.
  162.  
  163.               virtual RWCollectable*
  164.           ffffiiiirrrrsssstttt() const;
  165.  
  166.  
  167.      Redefined from class RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee.  Returns the item at the beginning
  168.      of the list.
  169.  
  170.               RWCollectable*
  171.           ggggeeeetttt();
  172.  
  173.  
  174.      Returns and rrrreeeemmmmoooovvvveeeessss the item at the beginning of the list.
  175.  
  176.               virtual unsigned
  177.           hhhhaaaasssshhhh() const;
  178.  
  179.  
  180.      Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee.
  181.  
  182.               virtual size_t
  183.           iiiinnnnddddeeeexxxx(const RWCollectable* c) const;
  184.  
  185.  
  186.      Redefined from class RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee.  Returns the index of the first item
  187.      that iiiissssEEEEqqqquuuuaaaallll to the item pointed to by cccc, or RRRRWWWW____NNNNPPPPOOOOSSSS if there is no such
  188.      index.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))                            RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))
  203.  
  204.  
  205.  
  206.               virtual RWCollectable*
  207.           iiiinnnnsssseeeerrrrtttt(RWCollectable* c);
  208.  
  209.  
  210.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.  Adds the item to the end of the
  211.      collection and returns it.  Returns nnnniiiillll if the insertion was
  212.      unsuccessful.
  213.  
  214.               void
  215.           iiiinnnnsssseeeerrrrttttAAAAtttt(size_t indx, RWCollectable* e);
  216.  
  217.  
  218.      Redefined from class RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee.  Adds a new item to the collection
  219.      at position iiiinnnnddddxxxx.  The item previously at position iiii is moved to iiii++++1111,
  220.      eeeettttcccc.  The index iiiinnnnddddxxxx must be between 0 and the number of items in the
  221.      collection, or an exception of type RRRRWWWWBBBBoooouuuunnnnddddssssEEEErrrrrrrr will occur.
  222.  
  223.               virtual RWClassID
  224.           iiiissssAAAA() const;
  225.  
  226.  
  227.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee to return ________RRRRWWWWDDDDLLLLIIIISSSSTTTTCCCCOOOOLLLLLLLLEEEECCCCTTTTAAAABBBBLLLLEEEESSSS.
  228.  
  229.               virtual RWBoolean
  230.           iiiissssEEEEmmmmppppttttyyyy() const;
  231.  
  232.  
  233.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  234.  
  235.               virtual RWCollectable*
  236.           llllaaaasssstttt() const;
  237.  
  238.  
  239.      Redefined from class RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee.  Returns the item at the end of the
  240.      list.
  241.  
  242.               virtual size_t
  243.           ooooccccccccuuuurrrrrrrreeeennnncccceeeessssOOOOffff(const RWCollectable* target) const;
  244.  
  245.  
  246.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.  Returns the number of items that
  247.      iiiissssEEEEqqqquuuuaaaallll to the item pointed to by ttttaaaarrrrggggeeeetttt.
  248.  
  249.               size_t
  250.           ooooccccccccuuuurrrrrrrreeeennnncccceeeessssOOOOffffRRRReeeeffffeeeerrrreeeennnncccceeee(const RWCollectable* e) const;
  251.  
  252.  
  253.      Returns the number of items that aaaarrrreeee iiiiddddeeeennnnttttiiiiccccaaaallll ttttoooo the item pointed to by
  254.      eeee (that is, that have the address eeee).
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))                            RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss((((3333CCCC++++++++))))
  269.  
  270.  
  271.  
  272.               virtual RWCollectable*
  273.           pppprrrreeeeppppeeeennnndddd(RWCollectable*);
  274.  
  275.  
  276.      Redefined from class RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee.  Adds the item to the beginning of
  277.      the collection and returns it.  Returns nnnniiiillll if the insertion was
  278.      unsuccessful.
  279.  
  280.               virtual RWCollectable*
  281.           rrrreeeemmmmoooovvvveeee(const RWCollectable* target);
  282.  
  283.  
  284.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.  Removes and returns the first item
  285.      that iiiissssEEEEqqqquuuuaaaallll to the item pointed to by ttttaaaarrrrggggeeeetttt.  Returns nnnniiiillll if there is
  286.      no such item.
  287.  
  288.               virtual void
  289.           rrrreeeemmmmoooovvvveeeeAAAAnnnnddddDDDDeeeessssttttrrrrooooyyyy(const RWCollectable* target);
  290.  
  291.  
  292.      Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  293.  
  294.               RWCollectable*
  295.           rrrreeeemmmmoooovvvveeeeRRRReeeeffffeeeerrrreeeennnncccceeee(const RWCollectable* e);
  296.  
  297.  
  298.      Removes and returns the first item that iiiissss iiiiddddeeeennnnttttiiiiccccaaaallll ttttoooo the item pointed
  299.      to by eeee (that is, that has the address eeee).  Returns nnnniiiillll if there is no
  300.      such item.
  301.  
  302.               virtual void
  303.           rrrreeeessssttttoooorrrreeeeGGGGuuuuttttssss(RWvistream&);
  304.           virtual void
  305.           rrrreeeessssttttoooorrrreeeeGGGGuuuuttttssss(RWFile&);
  306.           virtual void
  307.           ssssaaaavvvveeeeGGGGuuuuttttssss(RWvostream&) const;
  308.           virtual void
  309.           ssssaaaavvvveeeeGGGGuuuuttttssss(RWFile&) const;
  310.  
  311.  
  312.      Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  313.  
  314.               RWStringID
  315.           ssssttttrrrriiiinnnnggggIIIIDDDD();
  316.  
  317.  
  318.      (acts virtual) Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee.
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.